SwiWwanCmApi.h

/*===========================================================================
FILE: 
   SwiWwanCmApi.h

DESCRIPTION:
   Sierra Wireless WAN Connection Manager API for Gobi

Copyright (C) 2011 Sierra Wireless Incorporated. All rights reserved.
                   Sierra Wireless Proprietary/GTDR

/*=========================================================================*/
// Definitions
/*=========================================================================*/

#ifndef __SWIWWANCMAPI_H__
#define __SWIWWANCMAPI_H__

#ifdef GOBIAPI_EXPORTS
       #define SWIIMPORT extern "C" __declspec( dllexport )   
#else  //GOBIAPI_EXPORTS
    #ifdef __cplusplus
       /* C++ callable DLL */
       #define SWIIMPORT extern "C" __declspec( dllimport )   
    #else
       /* C callable DLL */
       #define SWIIMPORT __declspec( dllimport )
    #endif
#endif //GOBIAPI_EXPORTS

// Calling convention for API
#define SWICALLBACK __stdcall
#define SWICMAPI __stdcall



#ifdef __cplusplus
   extern "C" {
#endif


// RX/TX Packet counts callback function
typedef void (SWICALLBACK * tFNPacketTotals)(ULONG totalPacketTX, ULONG totalPacketRX);

// New NMEA sentence callback function
typedef void (SWICALLBACK * tFNNewNMEA)(LPCSTR pNMEA);

// New NMEA sentence plus mode callback function
typedef void (SWICALLBACK * tFNNewNMEAPlus)(LPCSTR pNMEA, ULONG mode);

// Signal strength information callback function
typedef void (SWICALLBACK * tFNSwiSignalStrengthInfo)(
        INT8    nCdmaRssi,
        ULONG   nCdmaEcio,
        INT8    nHdrRssi,
        ULONG   nHdrEcio,
        ULONG   nHdrSinr,
        ULONG   nHdrIo,
        INT8    nGsmRssi,
        INT8    nWcdmaRssi,
        ULONG   nWcdmaEcio,
        INT8    nLteRssi,
        INT8    nLteRsrq,
        INT16   nLteRsrp,
        UINT8   nLteSnr
        );

typedef void (SWICALLBACK * tFNEcio)(INT8 nEcio, ULONG nRadioIf);

typedef void (SWICALLBACK * tFNSnir)(ULONG nSnir);

typedef void (SWICALLBACK * tFNErrorRate)(ULONG nErrorRate, ULONG nRadioIf);

typedef void (SWICALLBACK * tFNRsrq)(INT8 nRsrq, ULONG nRadioIf);

typedef void (SWICALLBACK * tFNSwiDeviceRemoval)(ULONG nStatus);

SWIIMPORT ULONG SWICMAPI SwiSetDeviceRemovalCallback(tFNSwiDeviceRemoval pCallback);

SWIIMPORT ULONG SWICMAPI SwiSetEcioCallback(tFNEcio pCallback, BYTE nThreshold);

SWIIMPORT ULONG SWICMAPI SwiSetSnirCallback(tFNSnir pCallback, BYTE nThreshold);

SWIIMPORT ULONG SWICMAPI SwiSetErrorRateCallback(tFNErrorRate pCallback);

SWIIMPORT ULONG SWICMAPI SwiSetRsrqCallback(tFNRsrq pCallback, BYTE nThreshold);

SWIIMPORT ULONG SWICMAPI SwiGoDormant(void);

SWIIMPORT ULONG SWICMAPI GetRoutes( 
   ULONG*       pRouteInstances, 
   BYTE*        pRouteList );

SWIIMPORT ULONG SWICMAPI SetRoutes( 
   ULONG        nRouteInstances, 
   BYTE*        pRouteList );


SWIIMPORT ULONG SWICMAPI GetIPConfiguration(
    ULONG *     pIPAddress, 
    ULONG *     pGatewayAddress, 
    ULONG *     pSubnetMask, 
    ULONG *     pPrimaryDnsAddress, 
    ULONG *     pSecondaryDnsAddress );

SWIIMPORT ULONG SWICMAPI WCDMADecodeMOTextMsg(
        BYTE*    pMessage,
        BYTE*    pDestAddrLength,
        CHAR*    pDestAdd,
        BYTE*    pTextMsgLength,
        WCHAR*   pTextMsg,
        BYTE*    pScAddrLength,
        CHAR*    pScAddr,
        BOOLEAN* pRejectDuplicates,
        BOOLEAN* pStatusReportReq,
        BOOLEAN* pReplyPath,
        BYTE*    pValidityFormat,
        BYTE     validityPeriod[7],
        BOOLEAN* pConcatenatedMsg,
        ULONG*   pMsgRefNum,
        BYTE*    pTotalSegments,
        BYTE*    pSegmentNum);

SWIIMPORT ULONG SWICMAPI WCDMADecodeMTTextMsg(
        BYTE*    pMessage,
        BYTE*    pSenderAddrLength,
        CHAR*    pSenderAddr,
        BYTE*    pTextMsgLength,
        WCHAR*   pTextMsg,
        BYTE*    pScAddrLength,
        CHAR*    pScAddr,
        BOOLEAN* pMoreMsgSend,
        BOOLEAN* pReplyPath,
        BOOLEAN* pStatusReportInd,
        BYTE     scTimeStamp[7],
        BOOLEAN* pConcatenatedMsg,
        ULONG*   pMsgRefNum,
        BYTE*    pTotalSegments,
        BYTE*    pSegmentNum);

SWIIMPORT ULONG SWICMAPI CDMADecodeMTTextMsg(
        ULONG    messageLength,
        BYTE*    pMessage,
        ULONG*   pMessageID,
        BYTE*    pSenderAddrLength,
        CHAR*    pSenderAddr,
        BYTE*    pTextMsgLength,
        WCHAR*   pTextMsg,
        BYTE*    pPriority,
        BYTE*    pPrivacy,
        BYTE*    pLanguage,
        BYTE     mcTimeStamp[7],
        BYTE     absoluteValidity[7],
        BYTE*    pRelativeValidity,
        BYTE*    pDisplayMode,
        BOOL*    pUserAcknowledgementReq,
        BOOL*    pReadAcknowledgementReq,
        BYTE*    pAlertPriority,
        BYTE*    pCallbkAddrLength = NULL,
        CHAR*    pCallbkAddr = NULL
);

SWIIMPORT ULONG SWICMAPI WCDMAEncodeMOTextMsg(
        BYTE*    pMessageListSize,
        BYTE*    pMessageList,
        BYTE     messageRefNum,
        CHAR*    pDestAddr,
        ULONG    textMsgLength,
        WCHAR*   pTextMsg,
        CHAR*    pScAddr,
        BOOLEAN* pRejectDuplicates,
        BOOLEAN* pStatusReportReq,
        BOOLEAN* pReplyPath,
        BYTE*    pValidityFormat,
        BYTE     validityPeriod[7],
        BYTE*    pEncodingAlphabet);

SWIIMPORT ULONG SWICMAPI CDMAEncodeMOTextMsg(
        BYTE*    pMessageSize,
        BYTE*    pMessage,
        BYTE     messageId,
        CHAR*    pDestAddr,
        CHAR*    pCallbackAddr,
        ULONG    textMsgLength,
        WCHAR*   pTextMsg,
        BYTE*    pPriority,
        BYTE*    pEncodingAlphabet,
        BYTE*    pRelValidity = NULL);

SWIIMPORT ULONG SWICMAPI LTEDeleteSMS( 
   ULONG                      storageType, 
   ULONG *                    pMessageIndex, 
   ULONG *                    pMessageTag,
   ULONG *                    pMessageMode );

SWIIMPORT ULONG SWICMAPI LTEGetSMSList( 
   ULONG        storageType, 
   ULONG *      pRequestedTag,
   ULONG *      pMessageListSize, 
   BYTE *       pMessageList,
   ULONG *      pMessageMode );

SWIIMPORT ULONG SWICMAPI LTEGetSMS( 
   ULONG        storageType, 
   ULONG        messageIndex, 
   ULONG *      pMessageTag,
   ULONG *      pMessageFormat,
   ULONG *      pMessageSize, 
   BYTE *       pMessage,
   ULONG *      pMessageMode );

SWIIMPORT ULONG SWICMAPI LTEModifySMSStatus( 
   ULONG        storageType, 
   ULONG        messageIndex, 
   ULONG        messageTag,
   ULONG*       pMessageMode );

//  Build ID and Version ID)for the image specified by the given fully qualified 
//  path. Then the Image ID and Build ID can be used for SetImagePreferen 
//  function to upgrade firmware to the flash.
//              cqcn.mbn for Gobi3k, 
SWIIMPORT ULONG SWICMAPI GetImageInfo3KW( 
    WCHAR*      pDeviceID, 
    WCHAR*      pDeviceKey, 
    WCHAR*      pFilePath, 
    BYTE *      pImageType,
    BYTE *      pImageID,
    ULONG*      pVersionID,
    USHORT      versionSize,
    WCHAR*      pVersion );

SWIIMPORT ULONG SWICMAPI SwiGetServingNetwork( 
        ULONG * pRegistrationState, 
        ULONG * pCSDomain, 
        ULONG * pPSDomain, 
        ULONG * pRAN, 
        BYTE *  pRadioIfacesSize, 
        BYTE *  pRadioIfaces, 
        ULONG * pRoaming, 
        WORD *  pMCC, 
        WORD *  pMNC, 
        BYTE    nameSize, 
        CHAR *  pName, 
        WORD*   pSID,
        WORD*   pNID);

//
SWIIMPORT ULONG SWICMAPI GetWiFiState( ULONG * pState );

//
SWIIMPORT ULONG SWICMAPI SetWiFiState( ULONG state );

SWIIMPORT ULONG SWICMAPI InvokeApiCrash(ULONG nCrashMethod);

#ifndef SWI_STRUCT_DEFINED
struct SWI_STRUCT_TcpOpt
{
   ULONG nTcpWindowSize;

   ULONG        nTcpWindowSizeGlobal;

   ULONG        nTcpWindowSizeGlobalMax;

   bool bSackOpts;      

   ULONG nTcpMaxDupAcks;

   ULONG        nTcp1323Opts;

   ULONG        nTcpMaxConnectRetransmissions;
};
#define SWI_STRUCT_DEFINED
#endif

SWIIMPORT ULONG SWICMAPI SwiOptimizeTcp(LPCTSTR lpstrInterfaceID, SWI_STRUCT_TcpOpt sTcpOpt);

SWIIMPORT ULONG SWICMAPI SwiGetTcpOpt(LPCTSTR lpstrInterfaceID, SWI_STRUCT_TcpOpt &sTcpOpt);

SWIIMPORT ULONG SWICMAPI LTEGetAGPSConfig( 
   ULONG *      pServerAddress,
   ULONG *      pServerPort,
   ULONG        networkMode);

SWIIMPORT ULONG SWICMAPI LTESetAGPSConfig( 
   ULONG        serverAddress,
   ULONG        serverPort, 
   ULONG        networkMode);

SWIIMPORT ULONG SWICMAPI SetNMEAPlusCallback( tFNNewNMEAPlus pCallback );

SWIIMPORT ULONG SWICMAPI SWIOMADMInitApi();

SWIIMPORT ULONG SWICMAPI SWIOMADMShutdownApi();

SWIIMPORT ULONG SWICMAPI SWIOMADMSessionStart( ULONG sessionType );

SWIIMPORT ULONG SWICMAPI SWIOMADMSessionCancel( UINT8 sessionType);

SWIIMPORT ULONG SWICMAPI SWIOMADMSessionGetInfo( 
        UINT8   nSessionType,
        UINT8   nSessionState );

SWIIMPORT ULONG SWICMAPI SWIOMADMSelection( 
        UINT8   UserInput );

SWIIMPORT ULONG SWICMAPI SWIOMADMGetSettings( 
        UINT32  enabled,
        UINT8   fwAutoDownload,
        UINT8   fwAutoUpdate);

SWIIMPORT ULONG SWICMAPI SWIOMADMSetSettings( 
        UINT8   fwAutoLoad, 
        UINT8   fwAutoUpdate );

SWIIMPORT ULONG SWICMAPI SWIOMADMSetEventReport( );

typedef void (SWICALLBACK * tFNSWIOMADMFota)( 
        UINT8   SessionState,   
        UINT8   UserInputReq,
        UINT16  UserInputTimeout,
        UINT32  FWDownloadSize,
        UINT32  FWDownloadComplete,
        UINT16  UpdateStatus,
        UINT8   Severity,
        UINT16  VersionLength,
        BYTE*   Version,
        UINT16  NameLength, 
        BYTE*   PackageName, 
        UINT16  DescriptionLength,
        BYTE*   Description);

typedef void (SWICALLBACK * tFNSWIOMADMAlert)( 
        UINT8   SessionState,   
        UINT8   UserInputReq,
        UINT16  UserInputTimeout,
        UINT16  AlertMsgLength, 
        BYTE*   AlertMsg );

SWIIMPORT ULONG SWICMAPI SetSWIOMADMFotaCallback( tFNSWIOMADMFota pCallback );

SWIIMPORT ULONG SWICMAPI SetSWIOMADMAlertCallback( tFNSWIOMADMAlert pCallback );

SWIIMPORT ULONG SWICMAPI StartDataSessionLTE( 
   ULONG *      pTechnology, 
   ULONG *      pPrimaryDNSv4, 
   ULONG *      pSecondaryDNSv4, 
   ULONG *      pPrimaryNBNSv4, 
   ULONG *      pSecondaryNBNSv4, 
   ULONG *      pPrimaryDNSv6, 
   ULONG *      pSecondaryDNSv6,
   CHAR *       pAPNName, 
   ULONG *      pIPAddressv4, 
   ULONG *      pIPAddressv6,
   ULONG *      pAuthentication, 
   CHAR *       pUsername, 
   CHAR *       pPassword,
   ULONG *      pSessionId,
   ULONG *      pFailureReason );

SWIIMPORT ULONG SWICMAPI GetIPAddressLTE( 
    ULONG *             pIPAddressv4,
    USHORT *    pIPAddressv6,
    BYTE *              pIPv6prefixlen);

// Current data bearer technology callback function
typedef void (SWICALLBACK * tFNSwiCurrentDataBearer)( 
        ULONG NetworkType, 
        ULONG RatMask, 
        ULONG SoMask );

SWIIMPORT ULONG SWICMAPI SwiSetCurrentDataBearerCallback( tFNSwiCurrentDataBearer pCallback );

SWIIMPORT ULONG SWICMAPI SwiGetCurrentDataBearerTechnology( 
        ULONG*  pNetworkType,
        ULONG*  pRatMask,
        ULONG*  pSoMask);

SWIIMPORT ULONG SWICMAPI SwitchModemToBootMode();

SWIIMPORT ULONG SWICMAPI SetRfSarState( ULONG RfSarState );

SWIIMPORT ULONG SWICMAPI GetRfSarState( ULONG * pRfSarState );

SWIIMPORT ULONG SWICMAPI SwiGetSignalStrengthInfo( 
        INT8*   pCdmaRssi,
        ULONG*  pCdmaEcio,
        INT8*   pHdrRssi,
        ULONG*  pHdrEcio,
        ULONG*  pHdrSinr,
        ULONG*  pHdrIo,
        INT8*   pGsmRssi,
        INT8*   pWcdmaRssi,
        ULONG*  pWcdmaEcio,
        INT8*   pLteRssi,
        INT8*   pLteRsrq,
        INT16*  pLteRsrp,
        UINT8*  pLteSnr
        );

SWIIMPORT ULONG SWICMAPI SwiSetSignalStrengthInfoCallback( tFNSwiSignalStrengthInfo pCallback );

SWIIMPORT ULONG SWICMAPI SwiGetApn(
        BYTE nProfileType, 
        BYTE nProfileIndex, 
        BYTE nLength, 
        CHAR * pApn );


#ifdef __cplusplus
   };
#endif
 // End of WCM group
#endif // __SWIWWANCMAPI_H__